package com.github.cyf.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author chenyifan
 * @create 2024-03-26 15:18
 */
@Configuration
@EnableKnife4j
public class Knife4jConfig {

    /**
     * 全局参数设置：功能目录：文档管理 -> 全局参数设置
     * 目前全局参数功能主要提供两种参数类型：query(表单)、header(请求头)
     * 该功能是在还没有支持全局参数时临时配置的功能，如果后端 Swagger 有配置全局参数，该功能可以无视
     */

    /**
     * 前台 api
     * @return
     */
    @Bean(value = "apiV1")
    public Docket webApiConfig() {
        // Swagger 2 使用的是：DocumentationType.SWAGGER_2
        // Swagger 3 使用的是：DocumentationType.OAS_30
        return new Docket(DocumentationType.OAS_30)
                // 定义是否开启swagger，false为关闭，可以通过变量控制
                .enable(true)
                // 将api的元信息设置为包含在json ResourceListing响应中。
                .apiInfo(apiInfo())
                // 分组名称
                .groupName("v1")
                // 选择哪些接口作为swagger的doc发布
                .select()
                // 配置 Swagger 扫描 API 接口的基础包路径，
                // 它会扫描指定包及其子包下的所有带有 @Api 注解的 Controller 类，识别出其中的 Restful API 资源
                .apis(RequestHandlerSelectors.basePackage("com.github.cyf.controller.v1"))
                // 只包含路径以/api/开头的所有接口
                .paths(PathSelectors.ant("/api/**"))
                .build();
    }

    /**
     * 后台api
     * @return
     */
    @Bean(value = "apiV2")
    public Docket adminApiConfig() {
        return new Docket(DocumentationType.OAS_30)
                .enable(true)
                .apiInfo(apiInfo())
                .groupName("v2")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.github.cyf.controller.v2"))
                .paths(PathSelectors.ant("/admin/**"))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目 Restful API 说明文档")
                .contact(new Contact("cyf", "https://www.baidu.com/", "cyf1230330@163.com"))
                .description("基于Swagger2和Knife4j实现的接口文档")
                .termsOfServiceUrl("http://localhost:8080/")
                .version("1.0")
                .build();
    }
}
